All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.symantec.itools.vcafe.openapi.pluginapi.PluginFrame

Object
   |
   +----Component
           |
           +----Container
                   |
                   +----Window
                           |
                           +----Frame
                                   |
                                   +----EmbeddedFrame
                                           |
                                           +----WEmbeddedFrame
                                                   |
                                                   +----BasePluginWindow
                                                           |
                                                           +----BasePluginFrame
                                                                   |
                                                                   +----com.symantec.itools.vcafe.openapi.pluginapi.PluginFrame

public class PluginFrame

extends BasePluginFrame

Version:

1.0

Author:

Symantec Internet Tools Division

Since:

VCafe 3.0

See Also:

Plugin

com.symantec.itools.vcafe.openapi.pluginapi.PluginFrame()

Constructor to create a frame

com.symantec.itools.vcafe.openapi.pluginapi.PluginFrame(String)

Create a frame with the given title

getHelpId()

Get the help id used by this frame.

getMergeMenu()

Get the merge menu(s) being used by this frame

getVisualObjectAt(int, int)

Locates the VisualObject that contains the x,y position.

getVisualObjectBounds(VisualObject)

Returns the bounding rectangle of the given VisualObject

restore(InputStream)

Frame persistence.

save(OutputStream)

Frame persistence.

setDocking(boolean)

Enable/Disable docking of a frame.

setHelpId(int)

Set the help id for this frame.

setMergeMenu(MenuBar)

Set the menu(s) to append to Visual Cafe's menubar.

public PluginFrame()

Constructor to create a frame

public PluginFrame(String title)

Create a frame with the given title

Parameters:

title - The title on the frame

public int getHelpId()

Get the help id used by this frame.

Returns:

the help id being used by this frame

public java.awt.MenuBar getMergeMenu()

Get the merge menu(s) being used by this frame

Returns:

m the merge menu(s) being used by this frame

public com.symantec.itools.vcafe.openapi.VisualObject getVisualObjectAt(int x,
                                                                        int y)

Locates the VisualObject that contains the x,y position.

Parameters:

x - the x coordinate

y - the y coordinate

Returns:

null if there is no visual object containing position.

Overrides:

getVisualObjectAt in class BasePluginFrame

public java.awt.Rectangle getVisualObjectBounds(VisualObject vo)

Returns the bounding rectangle of the given VisualObject

Parameters:

vo - the VisualObject

Overrides:

getVisualObjectBounds in class BasePluginFrame

public void restore(InputStream is)

Frame persistence. Restore this frame window information such as size/location/docking etc.

Parameters:

is - the input stream from which to read the data

Overrides:

restore in class BasePluginFrame

public void save(OutputStream os)

Frame persistence. Save this frame window information such as size/location/docking etc.

Parameters:

os - the output stream to which data will be written

Overrides:

save in class BasePluginFrame

public void setDocking(boolean b)

Enable/Disable docking of a frame. The default implementation doesnot use docking.

Parameters:

b - true for docking window and false for regular window style

Overrides:

setDocking in class BasePluginFrame

public void setHelpId(int id)

Set the help id for this frame. Pressing F1 on an active plug in frame will invoke online help displaying the link specified by the given id.

Parameters:

id - the help id to use for this view

Overrides:

setHelpId in class BasePluginWindow

public void setMergeMenu(MenuBar m)

Set the menu(s) to append to Visual Cafe's menubar. The menu(s) show up only when this frame is active.

Parameters:

m - the menu(s) to add to Visual Cafe's menubar

Overrides:

setMergeMenu in class BasePluginFrame

All Packages  Class Hierarchy  This Package  Previous  Next  Index